<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <title>Engines sub-package &mdash; Dragonfly v0.6.4rc3 documentation</title>
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
          URL_ROOT:    '',
          VERSION:     '0.6.4rc3',
          COLLAPSE_MODINDEX: false,
          FILE_SUFFIX: '.html'
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <link rel="contents" title="Global table of contents" href="contents.html" />
    <link rel="index" title="Global index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="top" title="Dragonfly v0.6.4rc3 documentation" href="index.html" />
    <link rel="next" title="Actions sub-package" href="actions.html" />
    <link rel="prev" title="Grammar sub-package" href="grammar.html" />
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="modindex.html" title="Global Module Index"
             accesskey="M">modules</a> |</li>
        <li class="right" >
          <a href="actions.html" title="Actions sub-package"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="grammar.html" title="Grammar sub-package"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">Dragonfly v0.6.4rc3 documentation</a> &raquo;</li>
      </ul>
    </div>
    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  
  <div class="section" id="engines-sub-package">
<h1>Engines sub-package<a class="headerlink" href="#engines-sub-package" title="Permalink to this headline">¶</a></h1>
<p>Dragonfly supports multiple speech recognition engines as its backend.
The <em>engines</em> sub-package implements the interface code for each
supported engine.</p>
<div class="section" id="enginebase-class">
<h2>EngineBase class<a class="headerlink" href="#enginebase-class" title="Permalink to this headline">¶</a></h2>
<p>The <a title="dragonfly.engines.engine_base.EngineBase" class="reference internal" href="#dragonfly.engines.engine_base.EngineBase"><tt class="xref docutils literal"><span class="pre">dragonfly.engines.engine_base.EngineBase</span></tt></a> class forms the base
class for this specific speech recognition engine classes.  It defines
the stubs required and performs some of the logic necessary for
Dragonfly to be able to interact with a speech recognition engine.</p>
<dl class="class">
<dt id="dragonfly.engines.engine_base.EngineBase">
<!--[dragonfly.engines.engine_base.EngineBase]-->class <tt class="descname">EngineBase</tt><a class="headerlink" href="#dragonfly.engines.engine_base.EngineBase" title="Permalink to this definition">¶</a></dt>
<dd><dl class="attribute">
<dt id="dragonfly.engines.engine_base.EngineBase.is_available">
<!--[dragonfly.engines.engine_base.EngineBase.is_available]--><tt class="descname">is_available</tt><a class="headerlink" href="#dragonfly.engines.engine_base.EngineBase.is_available" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="dragonfly.engines.engine_base.EngineBase.language">
<!--[dragonfly.engines.engine_base.EngineBase.language]--><tt class="descname">language</tt><a class="headerlink" href="#dragonfly.engines.engine_base.EngineBase.language" title="Permalink to this definition">¶</a></dt>
<dd>Current user language of the SR engine.</dd></dl>

<dl class="method">
<dt id="dragonfly.engines.engine_base.EngineBase.mimic">
<!--[dragonfly.engines.engine_base.EngineBase.mimic]--><tt class="descname">mimic</tt><big>(</big><em>words</em><big>)</big><a class="headerlink" href="#dragonfly.engines.engine_base.EngineBase.mimic" title="Permalink to this definition">¶</a></dt>
<dd>Mimic a recognition of the given <em>words</em>.</dd></dl>

<dl class="method">
<dt id="dragonfly.engines.engine_base.EngineBase.speak">
<!--[dragonfly.engines.engine_base.EngineBase.speak]--><tt class="descname">speak</tt><big>(</big><em>text</em><big>)</big><a class="headerlink" href="#dragonfly.engines.engine_base.EngineBase.speak" title="Permalink to this definition">¶</a></dt>
<dd>Speak the given <em>text</em> using text-to-speech.</dd></dl>

</dd></dl>

<p>To be continued: compiler classes, natlink and wsr implementation classes.</p>
</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <h3>Table Of Contents</h3>
            <ul>
<li><a class="reference external" href="">Engines sub-package</a><ul>
<li><a class="reference external" href="#enginebase-class">EngineBase class</a></li>
</ul>
</li>
</ul>

            <h4>Previous topic</h4>
            <p class="topless"><a href="grammar.html" title="previous chapter">Grammar sub-package</a></p>
            <h4>Next topic</h4>
            <p class="topless"><a href="actions.html" title="next chapter">Actions sub-package</a></p>
            <h3>This Page</h3>
            <ul class="this-page-menu">
              <li><a href="_sources/engines.txt">Show Source</a></li>
            </ul>
            <h3>Quick search</h3>
            <form class="search" action="search.html" method="get">
              <input type="text" name="q" size="18" /> <input type="submit" value="Go" />
              <input type="hidden" name="check_keywords" value="yes" />
              <input type="hidden" name="area" value="default" />
            </form>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="modindex.html" title="Global Module Index"
             accesskey="M">modules</a> |</li>
        <li class="right" >
          <a href="actions.html" title="Actions sub-package"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="grammar.html" title="Grammar sub-package"
             accesskey="P">previous</a> |</li>
        <li><a href="index.html">Dragonfly v0.6.4rc3 documentation</a> &raquo;</li>
      </ul>
    </div>
    <div class="footer">
      &copy; Copyright 2008, Christo Butcher.
      Last updated on Feb 01, 2009.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
    </div>
  </body>
</html>